Accelerator Salesforce Global Product System API
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| product-response-get | Product Query Response Mapping for Salesforce |
| products-search-response | Product Query Response Mapping for Salesforce |
| update-pricebookentry-request | Pricebooks Update Mapping for Salesforce |
| create-pricebookentry-request | Pricebooks Create Mapping for Salesforce |
| create-exetranId-composite-request | Create External Id and External Id Product Join Mapping for Salesforce |
| update-exetranId-request | Update External Id Request for Salesforce |
| update-product-request | |
| create-product-composite-request | Create Product and ProductCatalog Mapping for Salesforce |
| create-related-objects-composite-request | Create ProductCategory, ProductCategoryProduct, PricebookEntry, External_IDc and External_Id_Product_Joinc Mapping for Salesforce |
product-response-get
Product Query Response Mapping for Salesforce
Source:
./src/main/resources/dwl/product-response-get.dwl
Mapping Tables
Maps Salesforce Product2 to CIM Product format
| CIM | Salesforce | Description |
|---|---|---|
| id | Id | The id of the Product in Salesforce |
| name | Name | The name of the Product in Salesforce |
| longDescription | Description | The description of the Product in Salesforce |
| description | Short_Description__c | The description of the Product in Salesforce |
| externalSourceRecord | External_ID__c | The external id of the Product in Salesforce |
| isSellable | IsActive | Indicates whether or not the product is active |
| type | Family | The family of the Product in Salesforce |
| primaryProductCategory | productCategory | The product category of the product retrieved using a separate call |
| productId | ProductCode | The id of the Product in Salesforce |
| productSKU | StockKeepingUnit | The sku of the Product in Salesforce |
| productStatus | Status__c | The status of the Product in Salesforce |
| auditInfo.createdBy | CreatedById | Identifies the system or user which created the product entry |
| auditInfo.createdDate | CreatedDate | Timestamp of when the product entry was created |
| auditInfo.updatedBy | LastModifiedById | Identifies the system or user which last updated the product entry |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the product entry was last updated |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the product has been soft-deleted |
products-search-response
Product Query Response Mapping for Salesforce
Source:
./src/main/resources/dwl/products-search-response.dwl
Mapping Tables
Maps Salesforce Product2 to CIM Product format
| CIM | Salesforce | Description |
|---|---|---|
| id | Id | The id of the Product in Salesforce |
| name | Name | The name of the Product in Salesforce |
| longDescription | Description | The description of the Product in Salesforce |
| description | Short_Description__c | The description of the Product in Salesforce |
| externalSourceRecord | External_ID__c | The external id of the Product in Salesforce |
| isSellable | IsActive | Indicates whether or not the product is active |
| type | Family | The family of the Product in Salesforce |
| primaryProductCategory | productCategory | The product category of the product retrieved using a separate call |
| productId | ProductCode | The id of the Product in Salesforce |
| productSKU | StockKeepingUnit | The sku of the Product in Salesforce |
| productStatus | Status__c | The status of the Product in Salesforce |
| auditInfo.createdBy | CreatedById | Identifies the system or user which created the product entry |
| auditInfo.createdDate | CreatedDate | Timestamp of when the product entry was created |
| auditInfo.updatedBy | LastModifiedById | Identifies the system or user which last updated the product entry |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the product entry was last updated |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the product has been soft-deleted |
update-pricebookentry-request
Pricebooks Update Mapping for Salesforce
Source:
./src/main/resources/dwl/update-pricebookentry-request.dwl
Mapping Tables
Maps CIM PricebookEntry to Salesforce PricebookEntry format
| Salesforce | CIM | Description |
|---|---|---|
| Id | vars.pricebookEntryRecordList[0].Id | The Identifier of the existing standard pricebook entry |
| IsActive | true | Indicates whether or not the pricebookEntry is active |
| UnitPrice | unitListPrice | The unitListPrice of the pricebookEntry |
create-pricebookentry-request
Pricebooks Create Mapping for Salesforce
Source:
./src/main/resources/dwl/create-pricebookentry-request.dwl
Mapping Tables
Maps CIM PricebookEntry to Salesforce PricebookEntry format
| Salesforce | CIM | Description |
|---|---|---|
| IsActive | true | Indicates whether or not the pricebookEntry is active |
| Pricebook2Id | Pricebook2Id | The id of the pricebookEntry |
| Product2Id | productId | The id of the product |
| UnitPrice | unitListPrice | The unitListPrice of the pricebookEntry |
create-exetranId-composite-request
Create External Id and External Id Product Join Mapping for Salesforce
Source:
./src/main/resources/dwl/create-exetranId-composite-request.dwl
Mapping Tables
Map Request for External Id and External Id Product Join Composite Objects
| Salesforce Object | Data | Description |
|---|---|---|
| External_IDc.DESCRIPTIONc | Description | Description for External Id |
| External_IDc.EXTERNAL_ID_TYPEc | ExternalTypeId | Id of External Id Type |
| External_ID__c.Name | Product | Name for External Id |
| External_IDc.STATUSc | VALID | Status for External Id |
| External_IDc.EXTERNAL_IDc | externalId | External Id value |
| External_Id_Product_Join__c.Name | ProductJoin | Name of External Id Product Join |
| External_Id_Product_Joinc.Descriptionc | Join External Id and Product Id | Description for External Id Product Join |
| External_Id_Product_Joinc.Product_Idc | productId | Product Id for External Id Product Join |
| External_Id_Product_Joinc.External_Idc | ExternalId.id | External Id value |
update-exetranId-request
Update External Id Request for Salesforce
Source:
./src/main/resources/dwl/update-exetranId-request.dwl
Mapping Tables
Maps CIM ExternalId to Salesforce External_Id__C
| CIM | Salesforce | Description |
|---|---|---|
| Id | externalId | External Id of product |
| Description__c | Description | Description for External Id |
| EXTERNAL_ID_TYPE__c | externalIdTypeId | The id of External Id Type |
| Name | Product | Name of External Id |
| STATUS__c | status | Status of External Id |
| EXTERNAL_ID__c | externalId | External Id value |
update-product-request
Source:
./src/main/resources/dwl/update-product-request.dwl
create-product-composite-request
Create Product and ProductCatalog Mapping for Salesforce
Source:
./src/main/resources/dwl/create-product-composite-request.dwl
Mapping Tables
Map Request for Product and ProductCatalog Composite Objects
| Salesforce Object | Data | Description |
|---|---|---|
| Product2.Name | name | name of the product |
| Product2.ProductCode | ProductCode | SKU of the product |
| Product2.Product_Catalog__c | catalog name | name of the product catalog |
| Product2.Description | longDescription | product description |
| Product2.Item_Long_Description__c | longDescription | product description |
| Product2.Short_Description__c | description | product description |
| Product2.Item_Short_Description__c | description | product description |
| Product2.Status__c | Approved | status of the product |
| Product2.External_ID__c | externalSourceRecord | external source record of the product |
| Product2.ExternalId | externalSourceRecord | external source record of the product |
| Product2.Family | type | type of the product |
| Product2.IsActive | isSellable | sellable status of the product |
| Product2.StockKeepingUnit | productCode | SKU of the product |
| Product2.Global_Product_Id__c | mdmGlobalProductId | MDM global id of the product |
| ProductCatalog.Name | name | name of the product catalog |
create-related-objects-composite-request
Create ProductCategory, ProductCategoryProduct, PricebookEntry, External_IDc and External_Id_Product_Joinc Mapping for Salesforce
Source:
./src/main/resources/dwl/create-related-objects-composite-request.dwl
Mapping Tables
Map Request for Product and ProductCatalog Composite Objects
| Salesforce Object | Data | Description |
|---|---|---|
| ProductCategory.CatalogId | catalogId | Id of the product catalog |
| ProductCategory.Name | categoryName | name of the product category |
| ProductCategory.ParentCategoryId | parentCategory | parent category name of the product category |
| ProductCategoryProduct.ProductCategoryId | categoryId | Id of the product category |
| ProductCategoryProduct.ProductId | ProductId | Id of the product |
| PricebookEntry.IsActive | true | active state of the price book entry |
| PricebookEntry.Pricebook2Id | pricebook2Id | Id of the price book entry |
| PricebookEntry.Product2Id | ProductId | Id of the product |
| PricebookEntry.UnitPrice | unitPrice | unit price of the product |
| External_IDc.Descriptionc | Description | description of the external id |
| External_IDc.EXTERNAL_ID_TYPEc | externalIdType | external id type name |
| External_ID__c.Name | ExternalID | external id name |
| External_IDc.STATUSc | VALID | external id status |
| External_IDc.EXTERNAL_IDc | uuid | external id |
| External_Id_Product_Join__c.Name | name | external id product join name |
| External_Id_Product_Joinc.Descriptionc | description | external id product join descri[tion |
| External_Id_Product_Joinc.Product_Idc | productId | product id |
| External_Id_Product_Joinc.EXTERNAL_IDc | ExternalId.id | id of external id |